home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / X11 / XChangeKeyboardControl.z / XChangeKeyboardControl
Encoding:
Text File  |  1998-10-30  |  13.7 KB  |  289 lines
  1.  
  2.  
  3.  
  4.      XXXXCCCChhhhaaaannnnggggeeeeKKKKeeeeyyyybbbbooooaaaarrrrddddCCCCoooonnnnttttrrrroooollll((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXCCCChhhhaaaannnnggggeeeeKKKKeeeeyyyybbbbooooaaaarrrrddddCCCCoooonnnnttttrrrroooollll((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XChangeKeyboardControl, XGetKeyboardControl, XAutoRepeatOn,
  10.           XAutoRepeatOff, XBell, XQueryKeymap, XKeyboardControl -
  11.           manipulate keyboard settings and keyboard control structure
  12.  
  13.      SSSSYYYYNNNNTTTTAAAAXXXX
  14.           XChangeKeyboardControl(_d_i_s_p_l_a_y, _v_a_l_u_e__m_a_s_k, _v_a_l_u_e_s)
  15.                 Display *_d_i_s_p_l_a_y;
  16.                 unsigned long _v_a_l_u_e__m_a_s_k;
  17.                 XKeyboardControl *_v_a_l_u_e_s;
  18.  
  19.           XGetKeyboardControl(_d_i_s_p_l_a_y, _v_a_l_u_e_s__r_e_t_u_r_n)
  20.                 Display *_d_i_s_p_l_a_y;
  21.                 XKeyboardState *_v_a_l_u_e_s__r_e_t_u_r_n;
  22.  
  23.           XAutoRepeatOn(_d_i_s_p_l_a_y)
  24.                 Display *_d_i_s_p_l_a_y;
  25.  
  26.           XAutoRepeatOff(_d_i_s_p_l_a_y)
  27.                 Display *_d_i_s_p_l_a_y;
  28.  
  29.           XBell(_d_i_s_p_l_a_y, _p_e_r_c_e_n_t)
  30.                 Display *_d_i_s_p_l_a_y;
  31.                 int _p_e_r_c_e_n_t;
  32.  
  33.           XQueryKeymap(_d_i_s_p_l_a_y, _k_e_y_s__r_e_t_u_r_n)
  34.                 Display *_d_i_s_p_l_a_y;
  35.                 char _k_e_y_s__r_e_t_u_r_n[32];
  36.  
  37.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  38.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  39.  
  40.           _k_e_y_s__r_e_t_u_r_n
  41.                     Returns an array of bytes that identifies which
  42.                     keys are pressed down.  Each bit represents one
  43.                     key of the keyboard.
  44.  
  45.           _p_e_r_c_e_n_t   Specifies the volume for the bell, which can range
  46.                     from -100 to 100 inclusive.
  47.  
  48.           _v_a_l_u_e__m_a_s_k
  49.                     Specifies which controls to change.  This mask is
  50.                     the bitwise inclusive OR of the valid control mask
  51.                     bits.
  52.  
  53.           _v_a_l_u_e_s    Specifies one value for each bit set to 1 in the
  54.                     mask.
  55.  
  56.           _v_a_l_u_e_s__r_e_t_u_r_n
  57.                     Returns the current keyboard controls in the
  58.                     specified _X_K_e_y_b_o_a_r_d_S_t_a_t_e structure.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXCCCChhhhaaaannnnggggeeeeKKKKeeeeyyyybbbbooooaaaarrrrddddCCCCoooonnnnttttrrrroooollll((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXCCCChhhhaaaannnnggggeeeeKKKKeeeeyyyybbbbooooaaaarrrrddddCCCCoooonnnnttttrrrroooollll((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  75.           The _X_C_h_a_n_g_e_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l function controls the keyboard
  76.           characteristics defined by the _X_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l structure.
  77.           The value_mask argument specifies which values are to be
  78.           changed.
  79.  
  80.           _X_C_h_a_n_g_e_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l can generate _B_a_d_M_a_t_c_h and _B_a_d_V_a_l_u_e
  81.           errors.
  82.  
  83.           The _X_G_e_t_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l function returns the current control
  84.           values for the keyboard to the _X_K_e_y_b_o_a_r_d_S_t_a_t_e structure.
  85.  
  86.           The _X_A_u_t_o_R_e_p_e_a_t_O_n function turns on auto-repeat for the
  87.           keyboard on the specified display.
  88.  
  89.           The _X_A_u_t_o_R_e_p_e_a_t_O_f_f function turns off auto-repeat for the
  90.           keyboard on the specified display.
  91.  
  92.           The _X_B_e_l_l function rings the bell on the keyboard on the
  93.           specified display, if possible.  The specified volume is
  94.           relative to the base volume for the keyboard.  If the value
  95.           for the percent argument is not in the range -100 to 100
  96.           inclusive, a _B_a_d_V_a_l_u_e error results.  The volume at which
  97.           the bell rings when the percent argument is nonnegative is:
  98.  
  99.                base - [(base * percent) / 100] + percent
  100.  
  101.           The volume at which the bell rings when the percent argument
  102.           is negative is:
  103.  
  104.                base + [(base * percent) / 100]
  105.  
  106.           To change the base volume of the bell, use
  107.           _X_C_h_a_n_g_e_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l.
  108.  
  109.           _X_B_e_l_l can generate a _B_a_d_V_a_l_u_e error.
  110.  
  111.           The _X_Q_u_e_r_y_K_e_y_m_a_p function returns a bit vector for the
  112.           logical state of the keyboard, where each bit set to 1
  113.           indicates that the corresponding key is currently pressed
  114.           down.  The vector is represented as 32 bytes.  Byte N (from
  115.           0) contains the bits for keys 8N to 8N + 7 with the least
  116.           significant bit in the byte representing key 8N.
  117.  
  118.           Note that the logical state of a device (as seen by client
  119.           applications) may lag the physical state if device event
  120.           processing is frozen.
  121.  
  122.      SSSSTTTTRRRRUUUUCCCCTTTTUUUURRRREEEESSSS
  123.           The _X_K_e_y_b_o_a_r_d_C_o_n_t_r_o_l structure contains:
  124.  
  125.           /* Mask bits for ChangeKeyboardControl */
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXCCCChhhhaaaannnnggggeeeeKKKKeeeeyyyybbbbooooaaaarrrrddddCCCCoooonnnnttttrrrroooollll((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXCCCChhhhaaaannnnggggeeeeKKKKeeeeyyyybbbbooooaaaarrrrddddCCCCoooonnnnttttrrrroooollll((((3333XXXX11111111))))
  137.  
  138.  
  139.  
  140.           #define
  141.                     _K_B_K_e_y_C_l_i_c_k_P_e_r_c_e_n_t
  142.                                                 (1L<<0)
  144.           #define
  145.                     _K_B_B_e_l_l_P_e_r_c_e_n_t
  146.                                                 (1L<<1)
  148.           #define
  149.                     _K_B_B_e_l_l_P_i_t_c_h
  150.                                                 (1L<<2)
  152.           #define
  153.                     _K_B_B_e_l_l_D_u_r_a_t_i_o_n
  154.                                                 (1L<<3)
  156.           #define
  157.                     _K_B_L_e_d
  158.                                                 (1L<<4)
  160.           #define
  161.                     _K_B_L_e_d_M_o_d_e
  162.                                                 (1L<<5)
  164.           #define
  165.                     _K_B_K_e_y
  166.                                                 (1L<<6)
  168.           #define
  169.                     _K_B_A_u_t_o_R_e_p_e_a_t_M_o_d_e
  170.                                                 (1L<<7)
  172.           /* Values */
  173.  
  174.           typedef struct {
  175.                int key_click_percent;
  176.                int bell_percent;
  177.                int bell_pitch;
  178.                int bell_duration;
  179.                int led;
  180.                int led_mode;       /* LedModeOn, LedModeOff */
  181.                int key;
  182.                int auto_repeat_mode;/* AutoRepeatModeOff, AutoRepeatModeOn,
  183.                                       AutoRepeatModeDefault */
  184.           } XKeyboardControl;
  185.  
  186.           The key_click_percent member sets the volume for key clicks
  187.           between 0 (off) and 100 (loud) inclusive, if possible. A
  188.           setting of -1 restores the default.  Other negative values
  189.           generate a _B_a_d_V_a_l_u_e error.
  190.  
  191.           The bell_percent sets the base volume for the bell between 0
  192.           (off) and 100 (loud) inclusive, if possible. A setting of -1
  193.           restores the default.  Other negative values generate a
  194.           _B_a_d_V_a_l_u_e error.  The bell_pitch member sets the pitch
  195.           (specified in Hz) of the bell, if possible.  A setting of -1
  196.           restores the default.  Other negative values generate a
  197.           _B_a_d_V_a_l_u_e error.  The bell_duration member sets the duration
  198.           of the bell specified in milliseconds, if possible. A
  199.           setting of -1 restores the default.  Other negative values
  200.           generate a _B_a_d_V_a_l_u_e error.
  201.  
  202.           If both the led_mode and led members are specified, the
  203.           state of that LED is changed, if possible. The led_mode
  204.           member can be set to _L_e_d_M_o_d_e_O_n or _L_e_d_M_o_d_e_O_f_f.  If only
  205.           led_mode is specified, the state of all LEDs are changed, if
  206.           possible. At most 32 LEDs numbered from one are supported.
  207.           No standard interpretation of LEDs is defined.  If led is
  208.           specified without led_mode, a _B_a_d_M_a_t_c_h error results.
  209.  
  210.           If both the auto_repeat_mode and key members are specified,
  211.           the auto_repeat_mode of that key is changed (according to
  212.           _A_u_t_o_R_e_p_e_a_t_M_o_d_e_O_n, _A_u_t_o_R_e_p_e_a_t_M_o_d_e_O_f_f, or
  213.           _A_u_t_o_R_e_p_e_a_t_M_o_d_e_D_e_f_a_u_l_t), if possible.  If only
  214.           auto_repeat_mode is specified, the global auto_repeat_mode
  215.           for the entire keyboard is changed, if possible, and does
  216.  
  217.  
  218.  
  219.      Page 3                                          (printed 4/30/98)
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.      XXXXCCCChhhhaaaannnnggggeeeeKKKKeeeeyyyybbbbooooaaaarrrrddddCCCCoooonnnnttttrrrroooollll((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXCCCChhhhaaaannnnggggeeeeKKKKeeeeyyyybbbbooooaaaarrrrddddCCCCoooonnnnttttrrrroooollll((((3333XXXX11111111))))
  227.  
  228.  
  229.  
  230.           not affect the per-key settings.  If a key is specified
  231.           without an auto_repeat_mode, a _B_a_d_M_a_t_c_h error results.  Each
  232.           key has an individual mode of whether or not it should
  233.           auto-repeat and a default setting for the mode.  In
  234.           addition, there is a global mode of whether auto-repeat
  235.           should be enabled or not and a default setting for that
  236.           mode.  When global mode is _A_u_t_o_R_e_p_e_a_t_M_o_d_e_O_n, keys should
  237.           obey their individual auto-repeat modes.  When global mode
  238.           is _A_u_t_o_R_e_p_e_a_t_M_o_d_e_O_f_f, no keys should auto-repeat.  An auto-
  239.           repeating key generates alternating _K_e_y_P_r_e_s_s and _K_e_y_R_e_l_e_a_s_e
  240.           events.  When a key is used as a modifier, it is desirable
  241.           for the key not to auto-repeat, regardless of its auto-
  242.           repeat setting.
  243.  
  244.           The _X_K_e_y_b_o_a_r_d_S_t_a_t_e structure contains:
  245.  
  246.           typedef struct {
  247.                int key_click_percent;
  248.                int bell_percent;
  249.                unsigned int bell_pitch, bell_duration;
  250.                unsigned long led_mask;
  251.                int global_auto_repeat;
  252.                char auto_repeats[32];
  253.           } XKeyboardState;
  254.  
  255.           For the LEDs, the least significant bit of led_mask
  256.           corresponds to LED one, and each bit set to 1 in led_mask
  257.           indicates an LED that is lit.  The global_auto_repeat member
  258.           can be set to _A_u_t_o_R_e_p_e_a_t_M_o_d_e_O_n or _A_u_t_o_R_e_p_e_a_t_M_o_d_e_O_f_f.  The
  259.           auto_repeats member is a bit vector.  Each bit set to 1
  260.           indicates that auto-repeat is enabled for the corresponding
  261.           key.  The vector is represented as 32 bytes. Byte N (from 0)
  262.           contains the bits for keys 8N to 8N + 7 with the least
  263.           significant bit in the byte representing key 8N.
  264.  
  265.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  266.           _B_a_d_M_a_t_c_h  Some argument or pair of arguments has the correct
  267.                     type and range but fails to match in some other
  268.                     way required by the request.
  269.  
  270.           _B_a_d_V_a_l_u_e  Some numeric value falls outside the range of
  271.                     values accepted by the request.  Unless a specific
  272.                     range is specified for an argument, the full range
  273.                     defined by the argument's type is accepted.  Any
  274.                     argument defined as a set of alternatives can
  275.                     generate this error.
  276.  
  277.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  278.           XChangeKeyboardMapping(3X11), XSetPointerMapping(3X11)
  279.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  280.  
  281.  
  282.  
  283.  
  284.  
  285.      Page 4                                          (printed 4/30/98)
  286.  
  287.  
  288.  
  289.